Get product catalogs

This article will guide you through how to retrieve product catalogs. The Postman collection will be used for all examples. You need a valid product catalogId to convert a basket to an order.

Prerequisites

• accessToken from Connect flow.
• cultureCode, e.g. en-US.
• priceGroupId either from your basket or from Get price groups.

Optional query parameters

• maxItems - limits the number of payment methods returned. The list is paginated.
• nextPagingToken - required to fetch the next page. The token is described in detail in Next Paging Token article

Get Product Catalogs

Open the Get Catalogs request.

Provide the mandatory query parameters - priceGroupId and cultureCode. Optional query parameters can be added as well.

Request:

    
    
    curl -D- -X GET {base_url}/api/v1/catalogs?cultureCode={cultureCode}&priceGroupId={priceGroupId}&maxItems={maxItems}&nextPagingToken={nextPagingToken} \
    -H 'Authorization: Bearer <ACCESS_TOKEN>'
    -H 'Content-Type: application/json' \
    
    

Response:

    
    
    {
        "pagingToken": "{pagingToken | null}",
        "catalogs": [
            {
                "id": "catalogId",
                "name": "catalogName"
            }
        ]
    }
    
    

Possible errors that may occur

See Handling failures for more info.